docs: use canonical 'docker scout environment' command name consistently#25100
Closed
mohithshuka wants to merge 4 commits into
Closed
docs: use canonical 'docker scout environment' command name consistently#25100mohithshuka wants to merge 4 commits into
mohithshuka wants to merge 4 commits into
Conversation
added 4 commits
May 15, 2026 16:36
The previous description said 'optimize your repository storage' which was vague and did not reflect the page's actual content. The manage.md page is focused on viewing, filtering, and deleting images and image indexes. Updated the description to accurately reflect this. Fixes docker#25005
The daemon configuration overview only mentioned two methods (JSON file and flags) but was missing the environment variables method via systemd. Added a new section explaining how to use systemd drop-in overrides to set daemon environment variables. Fixes docker#25062
Replace shorthand alias 'docker scout env' with the full canonical command name 'docker scout environment' in the environment integration overview page, matching the CLI reference and cli.md usage. Closes docker#25085
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
This PR seems to update multiple things. Please raise a single PR per change. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Docker docs to improve consistency and expand daemon configuration guidance.
Changes:
- Replaces uses of the
docker scout envalias withdocker scout environmentin the Scout environments integration overview. - Expands the Docker daemon configuration overview to add environment variables as a third configuration approach.
- Adds a systemd-based example for setting daemon options via environment variables.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| content/manuals/scout/integrations/environment/_index.md | Standardizes examples toward docker scout environment, but leaves a couple of env references that should be aligned. |
| content/manuals/engine/daemon/_index.md | Adds an environment-variable configuration section, but currently contains broken Markdown fences and potentially incorrect systemd/DOCKER_OPTS guidance. |
Comments suppressed due to low confidence (4)
content/manuals/scout/integrations/environment/_index.md:103
- This sentence still references the shorthand
docker scout enveven though the surrounding example output now usesdocker scout environment. To avoid reintroducing the inconsistency the PR is addressing, update this reference as well (or mentionenvas an alias once).
Alternatively, you can use the `docker scout env` command to view the images from the terminal.
```console
content/manuals/engine/daemon/_index.md:49
- After adding a third configuration method (environment variables), this paragraph still says "both of these options" and only discusses flags vs JSON. Reword to reflect all three methods, and clarify which combinations are valid/conflicting (e.g., systemd unit overrides vs
daemon.json).
This issue also appears on line 101 of the same file.
- Use environment variables to set daemon options.
You can use both of these options together as long as you don't specify the same
option both as a flag and in the JSON file. If that happens, the Docker daemon
won't start and prints an error message.
content/manuals/engine/daemon/_index.md:114
- This ini snippet fence is also mismatched (backtick counts), which will break rendering. Align it with the repo’s usual fenced code blocks (e.g.,
ini ...).
``````ini
[Service]
Environment="DOCKER_OPTS=--debug --tls=true"
**content/manuals/engine/daemon/_index.md:106**
* The systemd guidance here looks incorrect/incomplete: `Environment="DOCKER_OPTS=..."` won’t affect `dockerd` unless the unit file’s `ExecStart` expands/uses `$DOCKER_OPTS` (which is typically not the case). Consider documenting the supported approach (e.g., a drop-in that overrides `ExecStart=` to add the desired `dockerd` flags, or uses a documented environment variable that `dockerd` itself reads). Also, for consistency with other pages, the command is usually `sudo systemctl edit docker.service` and restart `docker.service`.
To set environment variables for the Docker daemon using systemd, create a
drop-in override file:
$ sudo systemctl edit docker
```````
```
</details>
---
💡 <a href="/docker/docs/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
Comment on lines
51
to
+55
| To see all of the available environments for an organization, you can use the | ||
| `docker scout env` command. | ||
|
|
||
| ```console | ||
| $ docker scout env | ||
| $ docker scout environment |
Comment on lines
+104
to
+107
| ````````console | ||
| $ sudo systemctl edit docker | ||
| ``````` | ||
|
|
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Replaced shorthand alias
docker scout envwith the full canonicalcommand name
docker scout environmentin the environment integrationoverview page (
_index.md).Why
The
_index.mdpage was usingdocker scout env(a shorthand alias)while
cli.mdand the official CLI reference both usedocker scout environment. This inconsistency was confusing for readers.Related
Closes #25085